<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - Sync</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Background.html">Background</a></li>
	
	<li><a href="../symbols/Display.html">Display</a></li>
	
	<li><a href="../symbols/Inject.html">Inject</a></li>
	
	<li><a href="../symbols/Investor.html">Investor</a></li>
	
	<li><a href="../symbols/Localizer.html">Localizer</a></li>
	
	<li><a href="../symbols/Metrics.html">Metrics</a></li>
	
	<li><a href="../symbols/Notification.html">Notification</a></li>
	
	<li><a href="../symbols/Options.html">Options</a></li>
	
	<li><a href="../symbols/Popup.html">Popup</a></li>
	
	<li><a href="../symbols/Portfolio.html">Portfolio</a></li>
	
	<li><a href="../symbols/Quote.html">Quote</a></li>
	
	<li><a href="../symbols/Settings.html">Settings</a></li>
	
	<li><a href="../symbols/Sources.html">Sources</a></li>
	
	<li><a href="../symbols/Sum.html">Sum</a></li>
	
	<li><a href="../symbols/Sync.html">Sync</a></li>
	
	<li><a href="../symbols/Updater.html">Updater</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class Sync
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/chromequotes_src_script_class__Sync.js.html">Sync.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Sync.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/Sync.html#constructor">Sync</a></b>()
							</div>
							<div class="description">This singleton contains all the methods used to sync local storageinformation within the Other Bookmarks folder</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Sync.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-BOOKMARK_NAME">BOOKMARK_NAME</a></b>
								</div>
								<div class="description">The name of the bookmark</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-BOOKMARK_URL">BOOKMARK_URL</a></b>
								</div>
								<div class="description">The base URL for the bookmark</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-MAIN_TREE_ID">MAIN_TREE_ID</a></b>
								</div>
								<div class="description">The main bookmark tree index</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-OTHER_BOOKMARKS_ID">OTHER_BOOKMARKS_ID</a></b>
								</div>
								<div class="description">Within the main tree, the Other Bookmarks folder is always given an indexof 1</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-syncing">syncing</a></b>
								</div>
								<div class="description">Whether currently syncing, to avoid event listeners from triggering tonsof events</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/Sync.html#-syncNode">syncNode</a></b>
								</div>
								<div class="description">A BookmarkTreeNode object that contains information on the bookmark nodebeing used for syncing</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Sync.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/Sync.html#-getSyncId">getSyncId</a></b>(callback)
								</div>
								<div class="description">Determines the bookmark ID to sync with, creating one if necessary</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.id">id</a></b>()
								</div>
								<div class="description">Returns the ID associated with the sync bookmark node</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.initialize">initialize</a></b>()
								</div>
								<div class="description">Arms all of the events that will trigger a reload</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.listen">listen</a></b>(toggle)
								</div>
								<div class="description">Attaches and detaches event listeners</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.load">load</a></b>(id)
								</div>
								<div class="description">Loads information from bookmark</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.overwrite">overwrite</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">Sync.<b><a href="../symbols/Sync.html#.save">save</a></b>()
								</div>
								<div class="description">Saves local storage to bookmark</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>Sync</b>()
				</div>
				
				<div class="description">
					This singleton contains all the methods used to sync local storageinformation within the Other Bookmarks folder
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="-BOOKMARK_NAME"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{string}</span>
					<b>BOOKMARK_NAME</b>
					
					</div>
					<div class="description">
						The name of the bookmark
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-BOOKMARK_URL"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{string}</span>
					<b>BOOKMARK_URL</b>
					
					</div>
					<div class="description">
						The base URL for the bookmark
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-MAIN_TREE_ID"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{number}</span>
					<b>MAIN_TREE_ID</b>
					
					</div>
					<div class="description">
						The main bookmark tree index
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-OTHER_BOOKMARKS_ID"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{number}</span>
					<b>OTHER_BOOKMARKS_ID</b>
					
					</div>
					<div class="description">
						Within the main tree, the Other Bookmarks folder is always given an indexof 1
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-syncing"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{boolean}</span>
					<b>syncing</b>
					
					</div>
					<div class="description">
						Whether currently syncing, to avoid event listeners from triggering tonsof events
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="-syncNode"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{object}</span>
					<b>syncNode</b>
					
					</div>
					<div class="description">
						A BookmarkTreeNode object that contains information on the bookmark nodebeing used for syncing
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="-getSyncId"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					<span class="light">{<a href="../symbols/Sync.html">Sync</a>}</span>
					<b>getSyncId</b>(callback)
					
					</div>
					<div class="description">
						Determines the bookmark ID to sync with, creating one if necessary
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{function}</span> <b>callback</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".id"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{number}</span>
					<span class="light">Sync.</span><b>id</b>()
					
					</div>
					<div class="description">
						Returns the ID associated with the sync bookmark node
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{number}</span> The ID number for the bookmark we're syncing with</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".initialize"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Sync.html">Sync</a>}</span>
					<span class="light">Sync.</span><b>initialize</b>()
					
					</div>
					<div class="description">
						Arms all of the events that will trigger a reload
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".listen"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Sync.html">Sync</a>}</span>
					<span class="light">Sync.</span><b>listen</b>(toggle)
					
					</div>
					<div class="description">
						Attaches and detaches event listeners
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>toggle</b>
									
								</dt>
								<dd>Whether to add or remove listeners, defaultingto true</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".load"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Sync.html">Sync</a>}</span>
					<span class="light">Sync.</span><b>load</b>(id)
					
					</div>
					<div class="description">
						Loads information from bookmark
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>id</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/Sync.html">Sync</a>}</span> The current object</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".overwrite"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">Sync.</span><b>overwrite</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".save"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{<a href="../symbols/Sync.html">Sync</a>}</span>
					<span class="light">Sync.</span><b>save</b>()
					
					</div>
					<div class="description">
						Saves local storage to bookmark
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>The current object</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Tue Mar 01 2011 22:30:51 GMT+0900 (JST)
		</div>
	</body>
</html>
